<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Biometric Embedded Platform: api/inc/fpc_bep_bio_param.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Biometric Embedded Platform
   &#160;<span id="projectnumber">fpc_bep_kaadas_21.0.1.002</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fpc__bep__bio__param_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">fpc_bep_bio_param.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Biometric API runtime parameters.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stddef.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &quot;<a class="el" href="fpc__bep__types_8h_source.html">fpc_bep_types.h</a>&quot;</code><br />
</div>
<p><a href="fpc__bep__bio__param_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__bep__general__param__t.html">fpc_bep_general_param_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">BEP library general configuration parameters.  <a href="structfpc__bep__general__param__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__bep__enroll__param__t.html">fpc_bep_enroll_param_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">BEP library enroll configuration parameters.  <a href="structfpc__bep__enroll__param__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__bep__identify__param__t.html">fpc_bep_identify_param_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">BEP library identify configuration parameters.  <a href="structfpc__bep__identify__param__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__bep__bio__param__t.html">fpc_bep_bio_param_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">BEP library biometric runtime configuration parameters.  <a href="structfpc__bep__bio__param__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a7b2c65bc4f81f00b74ef1cd11c9c7e01"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__bio__param_8h.html#a7b2c65bc4f81f00b74ef1cd11c9c7e01">fpc_bep_enroll_scheme_t</a> { <br />
&#160;&#160;<a class="el" href="fpc__bep__bio__param_8h.html#a7b2c65bc4f81f00b74ef1cd11c9c7e01a6668f3221c57cb37c6809f4cedbef8f6">FPC_BEP_ENROLL_SCHEME_TOUCH</a> = 0, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__bio__param_8h.html#a7b2c65bc4f81f00b74ef1cd11c9c7e01a319b4962caf4e63f4fcc41e177fd677c">FPC_BEP_ENROLL_SCHEME_STRICT</a> = 1, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__bio__param_8h.html#a7b2c65bc4f81f00b74ef1cd11c9c7e01a7362f75dd340dfe7da374c3929e18ca4">FPC_BEP_ENROLL_SCHEME_CUSTOM</a> = 2
<br />
 }<tr class="memdesc:a7b2c65bc4f81f00b74ef1cd11c9c7e01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fingerprint algorithm enroll scheme.  <a href="fpc__bep__bio__param_8h.html#a7b2c65bc4f81f00b74ef1cd11c9c7e01">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a7b2c65bc4f81f00b74ef1cd11c9c7e01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65019d87918cf7c2e3fbe40c5e75e0f4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__bio__param_8h.html#a65019d87918cf7c2e3fbe40c5e75e0f4">fpc_bep_latency_scheme_t</a> { <a class="el" href="fpc__bep__bio__param_8h.html#a65019d87918cf7c2e3fbe40c5e75e0f4ad40b69cb955655a0fb95baeff0aa9118">FPC_BEP_LATENCY_SCHEME_STANDARD</a> = 1
 }<tr class="memdesc:a65019d87918cf7c2e3fbe40c5e75e0f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fingerprint algorithm latency scheme.  <a href="fpc__bep__bio__param_8h.html#a65019d87918cf7c2e3fbe40c5e75e0f4">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a65019d87918cf7c2e3fbe40c5e75e0f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80e4c156c4cb37fb3abb656fe4d1527d"><td class="memItemLeft" align="right" valign="top"><a id="a80e4c156c4cb37fb3abb656fe4d1527d"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__bio__param_8h.html#a80e4c156c4cb37fb3abb656fe4d1527d">fpc_bep_security_level_t</a> { <br />
&#160;&#160;<b>FPC_BEP_SECURITY_LEVEL_FAR_20K</b> = 1, 
<br />
&#160;&#160;<b>FPC_BEP_SECURITY_LEVEL_FAR_50K</b> = 2, 
<br />
&#160;&#160;<b>FPC_BEP_SECURITY_LEVEL_FAR_100K</b> = 3, 
<br />
&#160;&#160;<b>FPC_BEP_SECURITY_LEVEL_FAR_500K</b> = 4
<br />
 }<tr class="memdesc:a80e4c156c4cb37fb3abb656fe4d1527d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fingerprint identification security levels. <br /></td></tr>
</td></tr>
<tr class="separator:a80e4c156c4cb37fb3abb656fe4d1527d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Biometric API runtime parameters. </p>
<p>Definitions of the runtime configuration parameters used in the biometric API of Biometric Embedded Platform (BEP) library. The library contains functionality for use with biometric hardware from Fingerprint Cards. It is targeting embedded systems with tight restrictions on available CPU, memory and storage resources.</p>
<p>The library is by definition executing in the same security domain as the caller, therefore the API does not define any security mechanisms and it is the responsibility of the caller to securely deliver and protect any sensitive data being delivered to other parts of the system.</p>
<dl class="section note"><dt>Note</dt><dd>This is a work-in-progress specification. Implementers are informed that this API may change without providing any backward compatibility. However it is FPC's ambition that the API shall remain compatible between releases. </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a7b2c65bc4f81f00b74ef1cd11c9c7e01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b2c65bc4f81f00b74ef1cd11c9c7e01">&#9670;&nbsp;</a></span>fpc_bep_enroll_scheme_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fpc__bep__bio__param_8h.html#a7b2c65bc4f81f00b74ef1cd11c9c7e01">fpc_bep_enroll_scheme_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Fingerprint algorithm enroll scheme. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7b2c65bc4f81f00b74ef1cd11c9c7e01a6668f3221c57cb37c6809f4cedbef8f6"></a>FPC_BEP_ENROLL_SCHEME_TOUCH&#160;</td><td class="fielddoc"><p>Algorithm enroll scheme only depending on number of touches. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7b2c65bc4f81f00b74ef1cd11c9c7e01a319b4962caf4e63f4fcc41e177fd677c"></a>FPC_BEP_ENROLL_SCHEME_STRICT&#160;</td><td class="fielddoc"><p>Algorithm enroll scheme for touch with overlap requirement. A new enrollment image is compared with previous images from same enrollment session, to secure it is the same finger that is always enrolled. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7b2c65bc4f81f00b74ef1cd11c9c7e01a7362f75dd340dfe7da374c3929e18ca4"></a>FPC_BEP_ENROLL_SCHEME_CUSTOM&#160;</td><td class="fielddoc"><p>Algorithm enroll scheme with flexibility where the enrollment can be finished prior to the enroll progress reaching 100%. This scheme can be used if a customized stop-criteria is preferred. </p>
</td></tr>
</table>

</div>
</div>
<a id="a65019d87918cf7c2e3fbe40c5e75e0f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65019d87918cf7c2e3fbe40c5e75e0f4">&#9670;&nbsp;</a></span>fpc_bep_latency_scheme_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fpc__bep__bio__param_8h.html#a65019d87918cf7c2e3fbe40c5e75e0f4">fpc_bep_latency_scheme_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Fingerprint algorithm latency scheme. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a65019d87918cf7c2e3fbe40c5e75e0f4ad40b69cb955655a0fb95baeff0aa9118"></a>FPC_BEP_LATENCY_SCHEME_STANDARD&#160;</td><td class="fielddoc"><p>Algorithm scheme for optimized biometric performance. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</a></li><li class="navelem"><a class="el" href="dir_d218fd71c02742082feaad64e43c1ecd.html">inc</a></li><li class="navelem"><a class="el" href="fpc__bep__bio__param_8h.html">fpc_bep_bio_param.h</a></li>
    <li class="footer">Generated on Tue Nov 9 2021 12:12:59 for Biometric Embedded Platform by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
